<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="utf-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge">
    <meta name="viewport" content="width=device-width, initial-scale=1">
    <title>Module::Metadata - Gather package and POD information from perl module files - Perldoc Browser</title>
    <link rel="search" href="https://perldoc.perl.org/opensearch.xml" type="application/opensearchdescription+xml" title="Perldoc Browser">
    <link rel="canonical" href="https://perldoc.perl.org/Module::Metadata">
    <link rel="stylesheet" href="https://stackpath.bootstrapcdn.com/bootstrap/4.5.2/css/bootstrap.min.css" integrity="sha384-JcKb8q3iqJ61gNV9KGb8thSsNjpSL0n8PARn9HuZOnIxN0hoP+VmmDGMN5t9UJ0Z" crossorigin="anonymous">
    <link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.5.0/styles/stackoverflow-light.min.css" integrity="sha512-cG1IdFxqipi3gqLmksLtuk13C+hBa57a6zpWxMeoY3Q9O6ooFxq50DayCdm0QrDgZjMUn23z/0PMZlgft7Yp5Q==" crossorigin="anonymous" />
    <style>
      body {
        background: #f4f4f5;
        color: #020202;
      }
      .navbar-dark {
        background-image: -webkit-linear-gradient(top, #005f85 0, #002e49 100%);
        background-image: -o-linear-gradient(top, #005f85 0, #002e49 100%);
        background-image: linear-gradient(to bottom, #005f85 0, #002e49 100%);
        filter: progid:DXImageTransform.Microsoft.gradient(startColorstr='#ff005f85', endColorstr='#ff002e49', GradientType=0);
        background-repeat: repeat-x;
      }
      .navbar-dark .navbar-nav .nav-link,
      .navbar-dark .navbar-nav .nav-link:focus { color: #fff }
      .navbar-dark .navbar-nav .nav-link:hover { color: #ffef68 }
      #wrapperlicious {
        margin: 0 auto;
        font: 0.9em 'Helvetica Neue', Helvetica, sans-serif;
        font-weight: normal;
        line-height: 1.5em;
        margin: 0;
        padding: 0;
      }
      #wrapperlicious h1 { font-size: 1.5em }
      #wrapperlicious h2 { font-size: 1.3em }
      #wrapperlicious h3 { font-size: 1.1em }
      #wrapperlicious h4 { font-size: 0.9em }
      #wrapperlicious h1, #wrapperlicious h2, #wrapperlicious h3,
      #wrapperlicious h4, #wrapperlicious dt {
        color: #020202;
        margin-top: 1em;
        margin-bottom: 1em;
        position: relative;
        font-weight: bold;
      }
      #wrapperlicious a { color: inherit; text-decoration: underline }
      #wrapperlicious #toc { text-decoration: none }
      #wrapperlicious a:hover { color: #2a2a2a }
      #wrapperlicious a img { border: 0 }
      #wrapperlicious :not(pre) > code {
        color: inherit;
        background-color: rgba(0, 0, 0, 0.04);
        border-radius: 3px;
        font: 0.9em Consolas, Menlo, Monaco, monospace;
        padding: 0.3em;
      }
      #wrapperlicious dd {
        margin: 0;
        margin-left: 2em;
      }
      #wrapperlicious dt {
        color: #2a2a2a;
        font-weight: bold;
        margin-left: 0.9em;
      }
      #wrapperlicious p {
        margin-bottom: 1em;
        margin-top: 1em;
      }
      #wrapperlicious li > p {
        margin-bottom: 0;
        margin-top: 0;
      }
      #wrapperlicious pre {
        border: 1px solid #c1c1c1;
        border-radius: 3px;
        font: 100% Consolas, Menlo, Monaco, monospace;
        margin-bottom: 1em;
        margin-top: 1em;
      }
      #wrapperlicious pre > code {
        display: block;
        background-color: #f6f6f6;
        font: 0.9em Consolas, Menlo, Monaco, monospace;
        line-height: 1.5em;
        text-align: left;
        white-space: pre;
        padding: 1em;
      }
      #wrapperlicious dl, #wrapperlicious ol, #wrapperlicious ul {
        margin-bottom: 1em;
        margin-top: 1em;
      }
      #wrapperlicious ul {
        list-style-type: square;
      }
      #wrapperlicious ul ul {
        margin-bottom: 0px;
        margin-top: 0px;
      }
      #footer {
        font-size: 0.8em;
        padding-top: 0.5em;
        text-align: center;
      }
      #more {
        display: inline;
        font-size: 0.8em;
      }
      #perldocdiv {
        background-color: #fff;
        border: 1px solid #c1c1c1;
        border-bottom-left-radius: 5px;
        border-bottom-right-radius: 5px;
        margin-left: auto;
        margin-right: auto;
        padding: 3em;
        padding-top: 1em;
        max-width: 960px;
      }
      #moduleversion { float: right }
      #wrapperlicious .leading-notice {
        font-style: italic;
        padding-left: 1em;
        margin-top: 1em;
        margin-bottom: 1em;
      }
      #wrapperlicious .permalink {
        display: none;
        left: -0.75em;
        position: absolute;
        padding-right: 0.25em;
        text-decoration: none;
      }
      #wrapperlicious h1:hover .permalink, #wrapperlicious h2:hover .permalink,
      #wrapperlicious h3:hover .permalink, #wrapperlicious h4:hover .permalink,
      #wrapperlicious dt:hover .permalink {
        display: block;
      }
    </style>
    <!-- Global site tag (gtag.js) - Google Analytics -->
    <script async src="https://www.googletagmanager.com/gtag/js?id=G-KVNWBNT5FB"></script>
    <script>
      window.dataLayer = window.dataLayer || [];
      function gtag(){dataLayer.push(arguments);}
      gtag('js', new Date());

      gtag('config', 'G-KVNWBNT5FB');
      gtag('config', 'UA-50555-3');
    </script>
  </head>
  <body>
    <nav class="navbar navbar-expand-md navbar-dark bg-dark justify-content-between">
  <button class="navbar-toggler" type="button" data-toggle="collapse" data-target="#navbarNav" aria-controls="navbarNav" aria-expanded="false" aria-label="Toggle navigation">
    <span class="navbar-toggler-icon"></span>
  </button>
  <a class="navbar-brand" href="https://perldoc.perl.org/">Perldoc Browser</a>
  <div class="collapse navbar-collapse" id="navbarNav">
    <ul class="navbar-nav mr-auto">
      <li class="nav-item dropdown text-nowrap">
        <a class="nav-link dropdown-toggle" href="./Module::Metadata.html#" id="dropdownlink-stable" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">5.35.0</a>
        <div class="dropdown-menu" aria-labelledby="dropdownlink-stable">
          <a class="dropdown-item" href="https://perldoc.perl.org/Module::Metadata">Latest</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.38.2/Module::Metadata">5.38.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.38.1/Module::Metadata">5.38.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.38.0/Module::Metadata">5.38.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.36.3/Module::Metadata">5.36.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.36.2/Module::Metadata">5.36.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.36.1/Module::Metadata">5.36.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.36.0/Module::Metadata">5.36.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.34.3/Module::Metadata">5.34.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.34.2/Module::Metadata">5.34.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.34.1/Module::Metadata">5.34.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.34.0/Module::Metadata">5.34.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.32.1/Module::Metadata">5.32.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.32.0/Module::Metadata">5.32.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.30.3/Module::Metadata">5.30.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.30.2/Module::Metadata">5.30.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.30.1/Module::Metadata">5.30.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.30.0/Module::Metadata">5.30.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.28.3/Module::Metadata">5.28.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.28.2/Module::Metadata">5.28.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.28.1/Module::Metadata">5.28.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.28.0/Module::Metadata">5.28.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.26.3/Module::Metadata">5.26.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.26.2/Module::Metadata">5.26.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.26.1/Module::Metadata">5.26.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.26.0/Module::Metadata">5.26.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.24.4/Module::Metadata">5.24.4</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.24.3/Module::Metadata">5.24.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.24.2/Module::Metadata">5.24.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.24.1/Module::Metadata">5.24.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.24.0/Module::Metadata">5.24.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.22.4/Module::Metadata">5.22.4</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.22.3/Module::Metadata">5.22.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.22.2/Module::Metadata">5.22.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.22.1/Module::Metadata">5.22.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.22.0/Module::Metadata">5.22.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.20.3/Module::Metadata">5.20.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.20.2/Module::Metadata">5.20.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.20.1/Module::Metadata">5.20.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.20.0/Module::Metadata">5.20.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.18.4/Module::Metadata">5.18.4</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.18.3/Module::Metadata">5.18.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.18.2/Module::Metadata">5.18.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.18.1/Module::Metadata">5.18.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.18.0/Module::Metadata">5.18.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.16.3/Module::Metadata">5.16.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.16.2/Module::Metadata">5.16.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.16.1/Module::Metadata">5.16.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.16.0/Module::Metadata">5.16.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.14.4/Module::Metadata">5.14.4</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.14.3/Module::Metadata">5.14.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.14.2/Module::Metadata">5.14.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.14.1/Module::Metadata">5.14.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.14.0/Module::Metadata">5.14.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.12.5/Module::Metadata">5.12.5</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.12.4/Module::Metadata">5.12.4</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.12.3/Module::Metadata">5.12.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.12.2/Module::Metadata">5.12.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.12.1/Module::Metadata">5.12.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.12.0/Module::Metadata">5.12.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.10.1/Module::Metadata">5.10.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.10.0/Module::Metadata">5.10.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.9/Module::Metadata">5.8.9</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.8/Module::Metadata">5.8.8</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.7/Module::Metadata">5.8.7</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.6/Module::Metadata">5.8.6</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.5/Module::Metadata">5.8.5</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.4/Module::Metadata">5.8.4</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.3/Module::Metadata">5.8.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.2/Module::Metadata">5.8.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.1/Module::Metadata">5.8.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.8.0/Module::Metadata">5.8.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.6.2/Module::Metadata">5.6.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.6.1/Module::Metadata">5.6.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.6.0/Module::Metadata">5.6.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.005_04/Module::Metadata">5.005_04</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.005_03/Module::Metadata">5.005_03</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.005_02/Module::Metadata">5.005_02</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.005_01/Module::Metadata">5.005_01</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.005/Module::Metadata">5.005</a>
        </div>
      </li>
      <li class="nav-item dropdown text-nowrap">
        <a class="nav-link dropdown-toggle" href="./Module::Metadata.html#" id="dropdownlink-dev" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">Dev</a>
        <div class="dropdown-menu" aria-labelledby="dropdownlink-dev">
          <a class="dropdown-item" href="https://perldoc.perl.org/blead/Module::Metadata">blead</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.39.6/Module::Metadata">5.39.6</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.39.5/Module::Metadata">5.39.5</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.39.4/Module::Metadata">5.39.4</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.39.3/Module::Metadata">5.39.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.39.2/Module::Metadata">5.39.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.39.1/Module::Metadata">5.39.1</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.38.0-RC2/Module::Metadata">5.38.0-RC2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.38.0-RC1/Module::Metadata">5.38.0-RC1</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.11/Module::Metadata">5.37.11</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.10/Module::Metadata">5.37.10</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.9/Module::Metadata">5.37.9</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.8/Module::Metadata">5.37.8</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.7/Module::Metadata">5.37.7</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.6/Module::Metadata">5.37.6</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.5/Module::Metadata">5.37.5</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.4/Module::Metadata">5.37.4</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.3/Module::Metadata">5.37.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.2/Module::Metadata">5.37.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.1/Module::Metadata">5.37.1</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.37.0/Module::Metadata">5.37.0</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.11/Module::Metadata">5.35.11</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.10/Module::Metadata">5.35.10</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.9/Module::Metadata">5.35.9</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.8/Module::Metadata">5.35.8</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.7/Module::Metadata">5.35.7</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.6/Module::Metadata">5.35.6</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.5/Module::Metadata">5.35.5</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.4/Module::Metadata">5.35.4</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.3/Module::Metadata">5.35.3</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.2/Module::Metadata">5.35.2</a>
          <a class="dropdown-item" href="https://perldoc.perl.org/5.35.1/Module::Metadata">5.35.1</a>
          <a class="dropdown-item active" href="./Module::Metadata.html">5.35.0</a>
        </div>
      </li>
      <li class="nav-item dropdown text-nowrap">
        <a class="nav-link dropdown-toggle" href="./Module::Metadata.html#" id="dropdownlink-nav" role="button" data-toggle="dropdown" aria-haspopup="true" aria-expanded="false">Documentation</a>
        <div class="dropdown-menu" aria-labelledby="dropdownlink-nav">
          <a class="dropdown-item" href="perl.html">Perl</a>
          <a class="dropdown-item" href="perlintro.html">Intro</a>
          <a class="dropdown-item" href="perl.html#Tutorials">Tutorials</a>
          <a class="dropdown-item" href="perlfaq.html">FAQs</a>
          <a class="dropdown-item" href="perl.html#Reference-Manual">Reference</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="perlop.html">Operators</a>
          <a class="dropdown-item" href="functions.html">Functions</a>
          <a class="dropdown-item" href="variables.html">Variables</a>
          <a class="dropdown-item" href="modules.html">Modules</a>
          <a class="dropdown-item" href="perlutil.html">Utilities</a>
          <div class="dropdown-divider"></div>
          <a class="dropdown-item" href="perlcommunity.html">Community</a>
          <a class="dropdown-item" href="perlhist.html">History</a>
        </div>
      </li>
    </ul>
    <ul class="navbar-nav">
      <script>
        function set_expand (expand) {
          var perldocdiv = document.getElementById('perldocdiv');
          var width = window.getComputedStyle(perldocdiv).getPropertyValue('max-width');
          var expanded = (width == '' || width == 'none') ? true : false;
          if (expand === null) {
            expand = !expanded;
          }
          if ((expand && !expanded) || (!expand && expanded)) {
            perldocdiv.style.setProperty('max-width', expand ? 'none' : '960px');
            var button_classlist = document.getElementById('content-expand-button').classList;
            if (expand) {
              button_classlist.add('btn-light');
              button_classlist.remove('btn-outline-light');
            } else {
              button_classlist.add('btn-outline-light');
              button_classlist.remove('btn-light');
            }
          }
          return expand;
        }
        function toggle_expand () {
          var expand = set_expand(null);
          document.cookie = 'perldoc_expand=' + (expand ? 1 : 0) + '; path=/; expires=Tue, 19 Jan 2038 03:14:07 UTC';
        }
        function read_expand () {
          return document.cookie.split(';').some(function (item) { return item.indexOf('perldoc_expand=1') >= 0 });
        }
        if (document.readyState === 'loading') {
          document.addEventListener('DOMContentLoaded', function () {
            if (read_expand()) {
              set_expand(true);
            }
          });
        } else if (read_expand()) {
          set_expand(true);
        }
      </script>
      <button id="content-expand-button" type="button" class="btn btn-outline-light d-none d-lg-inline-block mr-2" onclick="toggle_expand()">Expand</button>
    <ul>
    <form class="form-inline" method="get" action="https://perldoc.perl.org/5.35.0/search">
      <input class="form-control mr-3" type="search" name="q" placeholder="Search" aria-label="Search">
    </form>
  </div>
</nav>

    <div id="wrapperlicious" class="container-fluid">
      <div id="perldocdiv">
        <div id="links">
          <a href="./Module::Metadata.html">Module::Metadata</a>
          <div id="more">
            (<a href="./Module::Metadata.txt">source</a>,
            <a href="https://metacpan.org/pod/Module::Metadata">CPAN</a>)
          </div>
            <div id="moduleversion">version 1.000037</div>
        </div>
        <div class="leading-notice">
          You are viewing the version of this documentation from Perl 5.35.0.
            This is a development version of Perl.
        </div>
        <h1><a id="toc">CONTENTS</a></h1>
                  <ul>
              <li>
                <a class="text-decoration-none" href="./Module::Metadata.html#NAME">NAME</a>
              </li>
              <li>
                <a class="text-decoration-none" href="./Module::Metadata.html#VERSION">VERSION</a>
              </li>
              <li>
                <a class="text-decoration-none" href="./Module::Metadata.html#SYNOPSIS">SYNOPSIS</a>
              </li>
              <li>
                <a class="text-decoration-none" href="./Module::Metadata.html#DESCRIPTION">DESCRIPTION</a>
              </li>
              <li>
                <a class="text-decoration-none" href="./Module::Metadata.html#CLASS-METHODS">CLASS METHODS</a>
                            <ul>
              <li>
                <a class="text-decoration-none" href="./Module::Metadata.html#new_from_file($filename,-collect_pod-=%3E-1,-decode_pod-=%3E-1)">new_from_file($filename, collect_pod =&gt; 1, decode_pod =&gt; 1)</a>
              </li>
              <li>
                <a class="text-decoration-none" href="./Module::Metadata.html#new_from_handle($handle,-$filename,-collect_pod-=%3E-1,-decode_pod-=%3E-1)">new_from_handle($handle, $filename, collect_pod =&gt; 1, decode_pod =&gt; 1)</a>
              </li>
              <li>
                <a class="text-decoration-none" href="./Module::Metadata.html#new_from_module($module,-collect_pod-=%3E-1,-inc-=%3E-%5C@dirs,-decode_pod-=%3E-1)">new_from_module($module, collect_pod =&gt; 1, inc =&gt; \@dirs, decode_pod =&gt; 1)</a>
              </li>
              <li>
                <a class="text-decoration-none" href="./Module::Metadata.html#find_module_by_name($module,-%5C@dirs)">find_module_by_name($module, \@dirs)</a>
              </li>
              <li>
                <a class="text-decoration-none" href="./Module::Metadata.html#find_module_dir_by_name($module,-%5C@dirs)">find_module_dir_by_name($module, \@dirs)</a>
              </li>
              <li>
                <a class="text-decoration-none" href="./Module::Metadata.html#provides(-%25options-)">provides( %options )</a>
              </li>
              <li>
                <a class="text-decoration-none" href="./Module::Metadata.html#package_versions_from_directory($dir,-%5C@files?)">package_versions_from_directory($dir, \@files?)</a>
              </li>
              <li>
                <a class="text-decoration-none" href="./Module::Metadata.html#log_info-(internal)">log_info (internal)</a>
              </li>
          </ul>

              </li>
              <li>
                <a class="text-decoration-none" href="./Module::Metadata.html#OBJECT-METHODS">OBJECT METHODS</a>
                            <ul>
              <li>
                <a class="text-decoration-none" href="./Module::Metadata.html#name()">name()</a>
              </li>
              <li>
                <a class="text-decoration-none" href="./Module::Metadata.html#version($package)">version($package)</a>
              </li>
              <li>
                <a class="text-decoration-none" href="./Module::Metadata.html#filename()">filename()</a>
              </li>
              <li>
                <a class="text-decoration-none" href="./Module::Metadata.html#packages_inside()">packages_inside()</a>
              </li>
              <li>
                <a class="text-decoration-none" href="./Module::Metadata.html#pod_inside()">pod_inside()</a>
              </li>
              <li>
                <a class="text-decoration-none" href="./Module::Metadata.html#contains_pod()">contains_pod()</a>
              </li>
              <li>
                <a class="text-decoration-none" href="./Module::Metadata.html#pod($section)">pod($section)</a>
              </li>
              <li>
                <a class="text-decoration-none" href="./Module::Metadata.html#is_indexable($package)-or-is_indexable()">is_indexable($package) or is_indexable()</a>
              </li>
          </ul>

              </li>
              <li>
                <a class="text-decoration-none" href="./Module::Metadata.html#SUPPORT">SUPPORT</a>
              </li>
              <li>
                <a class="text-decoration-none" href="./Module::Metadata.html#AUTHOR">AUTHOR</a>
              </li>
              <li>
                <a class="text-decoration-none" href="./Module::Metadata.html#CONTRIBUTORS">CONTRIBUTORS</a>
              </li>
              <li>
                <a class="text-decoration-none" href="./Module::Metadata.html#COPYRIGHT-&amp;-LICENSE">COPYRIGHT &amp; LICENSE</a>
              </li>
          </ul>

      <h1 id="NAME"><a class="permalink" href="./Module::Metadata.html#NAME">#</a>NAME</h1>

<p>Module::Metadata - Gather package and POD information from perl module files</p>

<h1 id="VERSION"><a class="permalink" href="./Module::Metadata.html#VERSION">#</a>VERSION</h1>

<p>version 1.000037</p>

<h1 id="SYNOPSIS"><a class="permalink" href="./Module::Metadata.html#SYNOPSIS">#</a>SYNOPSIS</h1>

<pre><code>use Module::Metadata;

# information about a .pm file
my $info = Module::Metadata-&gt;new_from_file( $file );
my $version = $info-&gt;version;

# CPAN META &#39;provides&#39; field for .pm files in a directory
my $provides = Module::Metadata-&gt;provides(
  dir =&gt; &#39;lib&#39;, version =&gt; 2
);</code></pre>

<h1 id="DESCRIPTION"><a class="permalink" href="./Module::Metadata.html#DESCRIPTION">#</a>DESCRIPTION</h1>

<p>This module provides a standard way to gather metadata about a .pm file through (mostly) static analysis and (some) code execution. When determining the version of a module, the <code>$VERSION</code> assignment is <code>eval</code>ed, as is traditional in the CPAN toolchain.</p>

<h1 id="CLASS-METHODS"><a class="permalink" href="./Module::Metadata.html#CLASS-METHODS">#</a><a id="CLASS"></a>CLASS METHODS</h1>

<h2 id="new_from_file($filename,-collect_pod-=&gt;-1,-decode_pod-=&gt;-1)"><a class="permalink" href="./Module::Metadata.html#new_from_file($filename,-collect_pod-=%3E-1,-decode_pod-=%3E-1)">#</a><a id="new_from_file"></a><a id="new_from_file-filename-collect_pod-1-decode_pod-1"></a><code>new_from_file($filename, collect_pod =&gt; 1, decode_pod =&gt; 1)</code></h2>

<p>Constructs a <code>Module::Metadata</code> object given the path to a file. Returns undef if the filename does not exist.</p>

<p><code>collect_pod</code> is a optional boolean argument that determines whether POD data is collected and stored for reference. POD data is not collected by default. POD headings are always collected.</p>

<p>If the file begins by an UTF-8, UTF-16BE or UTF-16LE byte-order mark, then it is skipped before processing, and the content of the file is also decoded appropriately starting from perl 5.8.</p>

<p>Alternatively, if <code>decode_pod</code> is set, it will decode the collected pod sections according to the <code>=encoding</code> declaration.</p>

<h2 id="new_from_handle($handle,-$filename,-collect_pod-=&gt;-1,-decode_pod-=&gt;-1)"><a class="permalink" href="./Module::Metadata.html#new_from_handle($handle,-$filename,-collect_pod-=%3E-1,-decode_pod-=%3E-1)">#</a><a id="new_from_handle"></a><a id="new_from_handle-handle-filename-collect_pod-1-decode_pod-1"></a><code>new_from_handle($handle, $filename, collect_pod =&gt; 1, decode_pod =&gt; 1)</code></h2>

<p>This works just like <code>new_from_file</code>, except that a handle can be provided as the first argument.</p>

<p>Note that there is no validation to confirm that the handle is a handle or something that can act like one. Passing something that isn&#39;t a handle will cause a exception when trying to read from it. The <code>filename</code> argument is mandatory or undef will be returned.</p>

<p>You are responsible for setting the decoding layers on <code>$handle</code> if required.</p>

<h2 id="new_from_module($module,-collect_pod-=&gt;-1,-inc-=&gt;-\@dirs,-decode_pod-=&gt;-1)"><a class="permalink" href="./Module::Metadata.html#new_from_module($module,-collect_pod-=%3E-1,-inc-=%3E-%5C@dirs,-decode_pod-=%3E-1)">#</a><a id="new_from_module"></a><a id="new_from_module-module-collect_pod-1-inc-dirs-decode_pod-1"></a><code>new_from_module($module, collect_pod =&gt; 1, inc =&gt; \@dirs, decode_pod =&gt; 1)</code></h2>

<p>Constructs a <code>Module::Metadata</code> object given a module or package name. Returns undef if the module cannot be found.</p>

<p>In addition to accepting the <code>collect_pod</code> and <code>decode_pod</code> arguments as described above, this method accepts a <code>inc</code> argument which is a reference to an array of directories to search for the module. If none are given, the default is @INC.</p>

<p>If the file that contains the module begins by an UTF-8, UTF-16BE or UTF-16LE byte-order mark, then it is skipped before processing, and the content of the file is also decoded appropriately starting from perl 5.8.</p>

<h2 id="find_module_by_name($module,-\@dirs)"><a class="permalink" href="./Module::Metadata.html#find_module_by_name($module,-%5C@dirs)">#</a><a id="find_module_by_name"></a><a id="find_module_by_name-module-dirs"></a><code>find_module_by_name($module, \@dirs)</code></h2>

<p>Returns the path to a module given the module or package name. A list of directories can be passed in as an optional parameter, otherwise @INC is searched.</p>

<p>Can be called as either an object or a class method.</p>

<h2 id="find_module_dir_by_name($module,-\@dirs)"><a class="permalink" href="./Module::Metadata.html#find_module_dir_by_name($module,-%5C@dirs)">#</a><a id="find_module_dir_by_name"></a><a id="find_module_dir_by_name-module-dirs"></a><code>find_module_dir_by_name($module, \@dirs)</code></h2>

<p>Returns the entry in <code>@dirs</code> (or <code>@INC</code> by default) that contains the module <code>$module</code>. A list of directories can be passed in as an optional parameter, otherwise @INC is searched.</p>

<p>Can be called as either an object or a class method.</p>

<h2 id="provides(-%options-)"><a class="permalink" href="./Module::Metadata.html#provides(-%25options-)">#</a><a id="provides"></a><a id="provides-options"></a><code>provides( %options )</code></h2>

<p>This is a convenience wrapper around <code>package_versions_from_directory</code> to generate a CPAN META <code>provides</code> data structure. It takes key/value pairs. Valid option keys include:</p>

<dl>

<dt id="version-(required)"><a class="permalink" href="./Module::Metadata.html#version-(required)">#</a><a id="version"></a><a id="version-required"></a>version <b>(required)</b></dt>
<dd>

<p>Specifies which version of the <a href="./CPAN::Meta::Spec.html">CPAN::Meta::Spec</a> should be used as the format of the <code>provides</code> output. Currently only &#39;1.4&#39; and &#39;2&#39; are supported (and their format is identical). This may change in the future as the definition of <code>provides</code> changes.</p>

<p>The <code>version</code> option is required. If it is omitted or if an unsupported version is given, then <code>provides</code> will throw an error.</p>

</dd>
<dt id="dir"><a class="permalink" href="./Module::Metadata.html#dir">#</a>dir</dt>
<dd>

<p>Directory to search recursively for <i>.pm</i> files. May not be specified with <code>files</code>.</p>

</dd>
<dt id="files"><a class="permalink" href="./Module::Metadata.html#files">#</a>files</dt>
<dd>

<p>Array reference of files to examine. May not be specified with <code>dir</code>.</p>

</dd>
<dt id="prefix"><a class="permalink" href="./Module::Metadata.html#prefix">#</a>prefix</dt>
<dd>

<p>String to prepend to the <code>file</code> field of the resulting output. This defaults to <i>lib</i>, which is the common case for most CPAN distributions with their <i>.pm</i> files in <i>lib</i>. This option ensures the META information has the correct relative path even when the <code>dir</code> or <code>files</code> arguments are absolute or have relative paths from a location other than the distribution root.</p>

</dd>
</dl>

<p>For example, given <code>dir</code> of &#39;lib&#39; and <code>prefix</code> of &#39;lib&#39;, the return value is a hashref of the form:</p>

<pre><code>{
  &#39;Package::Name&#39; =&gt; {
    version =&gt; &#39;0.123&#39;,
    file =&gt; &#39;lib/Package/Name.pm&#39;
  },
  &#39;OtherPackage::Name&#39; =&gt; ...
}</code></pre>

<h2 id="package_versions_from_directory($dir,-\@files?)"><a class="permalink" href="./Module::Metadata.html#package_versions_from_directory($dir,-%5C@files?)">#</a><a id="package_versions_from_directory"></a><a id="package_versions_from_directory-dir-files"></a><code>package_versions_from_directory($dir, \@files?)</code></h2>

<p>Scans <code>$dir</code> for .pm files (unless <code>@files</code> is given, in which case looks for those files in <code>$dir</code> - and reads each file for packages and versions, returning a hashref of the form:</p>

<pre><code>{
  &#39;Package::Name&#39; =&gt; {
    version =&gt; &#39;0.123&#39;,
    file =&gt; &#39;Package/Name.pm&#39;
  },
  &#39;OtherPackage::Name&#39; =&gt; ...
}</code></pre>

<p>The <code>DB</code> and <code>main</code> packages are always omitted, as are any &quot;private&quot; packages that have leading underscores in the namespace (e.g. <code>Foo::_private</code>)</p>

<p>Note that the file path is relative to <code>$dir</code> if that is specified. This <b>must not</b> be used directly for CPAN META <code>provides</code>. See the <code>provides</code> method instead.</p>

<h2 id="log_info-(internal)"><a class="permalink" href="./Module::Metadata.html#log_info-(internal)">#</a><a id="log_info"></a><a id="log_info-internal"></a><code>log_info (internal)</code></h2>

<p>Used internally to perform logging; imported from Log::Contextual if Log::Contextual has already been loaded, otherwise simply calls warn.</p>

<h1 id="OBJECT-METHODS"><a class="permalink" href="./Module::Metadata.html#OBJECT-METHODS">#</a><a id="OBJECT"></a>OBJECT METHODS</h1>

<h2 id="name()"><a class="permalink" href="./Module::Metadata.html#name()">#</a><a id="name"></a><code>name()</code></h2>

<p>Returns the name of the package represented by this module. If there is more than one package, it makes a best guess based on the filename. If it&#39;s a script (i.e. not a *.pm) the package name is &#39;main&#39;.</p>

<h2 id="version($package)"><a class="permalink" href="./Module::Metadata.html#version($package)">#</a><a id="version1"></a><a id="version-package"></a><code>version($package)</code></h2>

<p>Returns the version as defined by the $VERSION variable for the package as returned by the <code>name</code> method if no arguments are given. If given the name of a package it will attempt to return the version of that package if it is specified in the file.</p>

<h2 id="filename()"><a class="permalink" href="./Module::Metadata.html#filename()">#</a><a id="filename"></a><code>filename()</code></h2>

<p>Returns the absolute path to the file. Note that this file may not actually exist on disk yet, e.g. if the module was read from an in-memory filehandle.</p>

<h2 id="packages_inside()"><a class="permalink" href="./Module::Metadata.html#packages_inside()">#</a><a id="packages_inside"></a><code>packages_inside()</code></h2>

<p>Returns a list of packages. Note: this is a raw list of packages discovered (or assumed, in the case of <code>main</code>). It is not filtered for <code>DB</code>, <code>main</code> or private packages the way the <code>provides</code> method does. Invalid package names are not returned, for example &quot;Foo:Bar&quot;. Strange but valid package names are returned, for example &quot;Foo::Bar::&quot;, and are left up to the caller on how to handle.</p>

<h2 id="pod_inside()"><a class="permalink" href="./Module::Metadata.html#pod_inside()">#</a><a id="pod_inside"></a><code>pod_inside()</code></h2>

<p>Returns a list of POD sections.</p>

<h2 id="contains_pod()"><a class="permalink" href="./Module::Metadata.html#contains_pod()">#</a><a id="contains_pod"></a><code>contains_pod()</code></h2>

<p>Returns true if there is any POD in the file.</p>

<h2 id="pod($section)"><a class="permalink" href="./Module::Metadata.html#pod($section)">#</a><a id="pod"></a><a id="pod-section"></a><code>pod($section)</code></h2>

<p>Returns the POD data in the given section.</p>

<h2 id="is_indexable($package)-or-is_indexable()"><a class="permalink" href="./Module::Metadata.html#is_indexable($package)-or-is_indexable()">#</a><a id="is_indexable"></a><a id="is_indexable-package-or-is_indexable"></a><code>is_indexable($package)</code> or <code>is_indexable()</code></h2>

<p>Available since version 1.000020.</p>

<p>Returns a boolean indicating whether the package (if provided) or any package (otherwise) is eligible for indexing by PAUSE, the Perl Authors Upload Server. Note This only checks for valid <code>package</code> declarations, and does not take any ownership information into account.</p>

<h1 id="SUPPORT"><a class="permalink" href="./Module::Metadata.html#SUPPORT">#</a>SUPPORT</h1>

<p>Bugs may be submitted through <a href="https://rt.cpan.org/Public/Dist/Display.html?Name=Module-Metadata">the RT bug tracker</a> (or <a href="mailto:bug-Module-Metadata@rt.cpan.org">bug-Module-Metadata@rt.cpan.org</a>).</p>

<p>There is also a mailing list available for users of this distribution, at <a href="http://lists.perl.org/list/cpan-workers.html">http://lists.perl.org/list/cpan-workers.html</a>.</p>

<p>There is also an irc channel available for users of this distribution, at <a href="irc://irc.perl.org/#toolchain"><code>#toolchain</code> on <code>irc.perl.org</code></a>.</p>

<h1 id="AUTHOR"><a class="permalink" href="./Module::Metadata.html#AUTHOR">#</a>AUTHOR</h1>

<p>Original code from Module::Build::ModuleInfo by Ken Williams &lt;kwilliams@cpan.org&gt;, Randy W. Sims &lt;RandyS@ThePierianSpring.org&gt;</p>

<p>Released as Module::Metadata by Matt S Trout (mst) &lt;mst@shadowcat.co.uk&gt; with assistance from David Golden (xdg) &lt;dagolden@cpan.org&gt;.</p>

<h1 id="CONTRIBUTORS"><a class="permalink" href="./Module::Metadata.html#CONTRIBUTORS">#</a>CONTRIBUTORS</h1>

<ul>

<li><p>Karen Etheridge &lt;ether@cpan.org&gt;</p>

</li>
<li><p>David Golden &lt;dagolden@cpan.org&gt;</p>

</li>
<li><p>Vincent Pit &lt;perl@profvince.com&gt;</p>

</li>
<li><p>Matt S Trout &lt;mst@shadowcat.co.uk&gt;</p>

</li>
<li><p>Chris Nehren &lt;apeiron@cpan.org&gt;</p>

</li>
<li><p>Tomas Doran &lt;bobtfish@bobtfish.net&gt;</p>

</li>
<li><p>Olivier Mengué &lt;dolmen@cpan.org&gt;</p>

</li>
<li><p>Graham Knop &lt;haarg@haarg.org&gt;</p>

</li>
<li><p>tokuhirom &lt;tokuhirom@gmail.com&gt;</p>

</li>
<li><p>Tatsuhiko Miyagawa &lt;miyagawa@bulknews.net&gt;</p>

</li>
<li><p>Christian Walde &lt;walde.christian@googlemail.com&gt;</p>

</li>
<li><p>Leon Timmermans &lt;fawaka@gmail.com&gt;</p>

</li>
<li><p>Peter Rabbitson &lt;ribasushi@cpan.org&gt;</p>

</li>
<li><p>Steve Hay &lt;steve.m.hay@googlemail.com&gt;</p>

</li>
<li><p>Jerry D. Hedden &lt;jdhedden@cpan.org&gt;</p>

</li>
<li><p>Craig A. Berry &lt;cberry@cpan.org&gt;</p>

</li>
<li><p>Craig A. Berry &lt;craigberry@mac.com&gt;</p>

</li>
<li><p>David Mitchell &lt;davem@iabyn.com&gt;</p>

</li>
<li><p>David Steinbrunner &lt;dsteinbrunner@pobox.com&gt;</p>

</li>
<li><p>Edward Zborowski &lt;ed@rubensteintech.com&gt;</p>

</li>
<li><p>Gareth Harper &lt;gareth@broadbean.com&gt;</p>

</li>
<li><p>James Raspass &lt;jraspass@gmail.com&gt;</p>

</li>
<li><p>Chris &#39;BinGOs&#39; Williams &lt;chris@bingosnet.co.uk&gt;</p>

</li>
<li><p>Josh Jore &lt;jjore@cpan.org&gt;</p>

</li>
<li><p>Kent Fredric &lt;kentnl@cpan.org&gt;</p>

</li>
</ul>

<h1 id="COPYRIGHT-&amp;-LICENSE"><a class="permalink" href="./Module::Metadata.html#COPYRIGHT-&amp;-LICENSE">#</a><a id="COPYRIGHT"></a><a id="COPYRIGHT-LICENSE"></a>COPYRIGHT &amp; LICENSE</h1>

<p>Original code Copyright (c) 2001-2011 Ken Williams. Additional code Copyright (c) 2010-2011 Matt Trout and David Golden. All rights reserved.</p>

<p>This library is free software; you can redistribute it and/or modify it under the same terms as Perl itself.</p>


      </div>
      <div id="footer">
        <p>Perldoc Browser is maintained by Dan Book (<a href="https://metacpan.org/author/DBOOK">DBOOK</a>). Please contact him via the <a href="https://github.com/Grinnz/perldoc-browser/issues">GitHub issue tracker</a> or <a href="mailto:dbook@cpan.org">email</a> regarding any issues with the site itself, search, or rendering of documentation.</p>

<p>The Perl documentation is maintained by the Perl 5 Porters in the development of Perl. Please contact them via the <a href="https://github.com/Perl/perl5/issues">Perl issue tracker</a>, the <a href="https://lists.perl.org/list/perl5-porters.html">mailing list</a>, or <a href="https://kiwiirc.com/client/irc.perl.org/p5p">IRC</a> to report any issues with the contents or format of the documentation.</p>


      </div>
    </div>
    <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.5.1/jquery.slim.min.js" integrity="sha512-/DXTXr6nQodMUiq+IUJYCt2PPOUjrHJ9wFrqpJ3XkgPNOZVfMok7cRw6CSxyCQxXn6ozlESsSh1/sMCTF1rL/g==" crossorigin="anonymous"></script>
    <script src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.16.1/umd/popper.min.js" integrity="sha512-ubuT8Z88WxezgSqf3RLuNi5lmjstiJcyezx34yIU2gAHonIi27Na7atqzUZCOoY4CExaoFumzOsFQ2Ch+I/HCw==" crossorigin="anonymous"></script>
    <script src="https://stackpath.bootstrapcdn.com/bootstrap/4.5.2/js/bootstrap.min.js" integrity="sha384-B4gt1jrGC7Jh4AgTPSdUtOBvfO8shuf57BaghqFfPlYxofvL8/KUEfYiJOMMV+rV" crossorigin="anonymous"></script>
    <script src="../highlight.pack.js"></script>
    <script>hljs.highlightAll();</script>
  </body>
</html>
